Delete Group
AutomatR.AWS.Activities.DeleteGroup
The "Delete Group" activity in AutomatR is part of the AWS IAM (Identity and Access Management) activities package, enabling automation processes to delete a specified IAM (Identity and Access Management) group within Amazon Web Services (AWS). This activity streamlines the process of managing IAM groups, enhancing the efficiency of automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Access Key ID | Provides the encrypted access key ID for your AWS account, enabling connection to the AWS IAM service. String variables containing the access key ID. |
| Secret Access Key | Provides the encrypted secret access key for your AWS account, enabling connection to the AWS IAM service. String variables containing the secret access key. |
| Region | Specifies the AWS region where the IAM group is located. Use the RegionEndpoint enumeration to set the region. |
| Name | Specifies the name of the IAM group that you want to delete. String variables containing the IAM group name. |
| Remove All Attached Entities | Enables the removal of all subordinate entities (policies, users, etc.) attached to the group before deleting the group. Boolean variables indicating whether to remove all attached entities. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Delete Group" activity. Useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the wait time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Result | Outputs the result of the "Delete Group" operation, indicating whether the deletion was successful or encountered errors. Variables of relevant types (e.g., Boolean variables) to store the operation result. |
How to use:
- Drag and drop the "Delete Group" activity onto the workflow.
- Configure the properties by providing the required inputs, such as access key ID, secret access key, region, and group name.
- Optionally, configure the delay, choose whether to remove all attached entities, and customize the display name.
- Execute the workflow to delete the specified IAM group within AWS.
Example: Consider an example where the "Delete Group" activity is used to delete an IAM group named "Developers" in the "us-east-1" region:
Delete Group:
Display Name: "Delete Developers Group"
Access Key ID: "**************"
Secret Access Key: "**************"
Region: "us-east-1"
Name: "Developers"
Remove All Attached Entities: true
Result: isDeleteSuccessful
In this example, the activity deletes the IAM group named "Developers" in the "us-east-1" region, removing all attached entities. The result of the operation (success or failure) is stored in the Boolean variable "isDeleteSuccessful" for further handling in the workflow.